SparkN0de-git - /page/blob.mu

Micron Document

--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

| SparkN0de-git | SparkN0de |

Node / ReticulumProjects / Reticulum.git / files / docs / markdown / examples.md

Displaying Rendered • View raw • Download

docs/markdown/examples.md HEAD (4fc8e03d) Text, 113.18 KB

Code Examples

A number of examples are included in the source distribution of Reticulum. You can use these examples to learn how to write your own programs.

Minimal

The Minimal example demonstrates the bare-minimum setup required to connect to a Reticulum network from your program. In about five lines of code, you will have the Reticulum Network Stack initialised, and ready to pass traffic in your program.

T282828

T8b949e##########################################################

T8b949e# This RNS example demonstrates a minimal setup, that #

T8b949e# will start up the Reticulum Network Stack, generate a #

T8b949e# new destination, and let the user send an announce. #

T8b949e##########################################################

Tff7b72import T7ee787argparse

Tff7b72import T7ee787sys

Tff7b72import T7ee787RNS

T8b949e# Let's define an app name. We'll use this for all

T8b949e# destinations we create. Since this basic example

T8b949e# is part of a range of example utilities, we'll put

T8b949e# them all within the app namespace "example_utilities"

Te6edf3APP_NAME Tff7b72= Ta5d6ff"Ta5d6ffexample_utilitiesTa5d6ff"

T8b949e# This initialisation is executed when the program is started

Tff7b72def Td2a8ffprogram_setupTb4b4b4(Te6edf3configpathTb4b4b4)Tb4b4b4:

T8b949e# We must first initialise Reticulum

Te6edf3reticulum Tff7b72= Te6edf3RNSTff7b72.Td2a8ffReticulumTb4b4b4(Te6edf3configpathTb4b4b4)

T8b949e# Randomly create a new identity for our example

Te6edf3identity Tff7b72= Te6edf3RNSTff7b72.Td2a8ffIdentityTb4b4b4(Tb4b4b4)

T8b949e# Using the identity we just created, we create a destination.

T8b949e# Destinations are endpoints in Reticulum, that can be addressed

T8b949e# and communicated with. Destinations can also announce their

T8b949e# existence, which will let the network know they are reachable

T8b949e# and automatically create paths to them, from anywhere else

T8b949e# in the network.

Te6edf3destination Tff7b72= Te6edf3RNSTff7b72.Td2a8ffDestinationTb4b4b4(

Te6edf3identityTb4b4b4,

Te6edf3RNSTff7b72.Td2a8ffDestinationTff7b72.Td2a8ffINTb4b4b4,

Te6edf3RNSTff7b72.Td2a8ffDestinationTff7b72.Td2a8ffSINGLETb4b4b4,

Te6edf3APP_NAMETb4b4b4,

Ta5d6ff"Ta5d6ffminimalsampleTa5d6ff"

Tb4b4b4)

T8b949e# We configure the destination to automatically prove all

T8b949e# packets addressed to it. By doing this, RNS will automatically

T8b949e# generate a proof for each incoming packet and transmit it

T8b949e# back to the sender of that packet. This will let anyone that

T8b949e# tries to communicate with the destination know whether their

T8b949e# communication was received correctly.

Te6edf3destinationTff7b72.Td2a8ffset_proof_strategyTb4b4b4(Te6edf3RNSTff7b72.Td2a8ffDestinationTff7b72.Td2a8ffPROVE_ALLTb4b4b4)

T8b949e# Everything's ready!

T8b949e# Let's hand over control to the announce loop

Te6edf3announceLoopTb4b4b4(Te6edf3destinationTb4b4b4)

Tff7b72def Td2a8ffannounceLoopTb4b4b4(Te6edf3destinationTb4b4b4)Tb4b4b4:

T8b949e# Let the user know that everything is ready

Te6edf3RNSTff7b72.Td2a8fflogTb4b4b4(

Ta5d6ff"Ta5d6ffMinimal example Ta5d6ff"Tff7b72+

Te6edf3RNSTff7b72.Td2a8ffprettyhexrepTb4b4b4(Te6edf3destinationTff7b72.Td2a8ffhashTb4b4b4)Tff7b72+

Ta5d6ff"Ta5d6ff running, hit enter to manually send an announce (Ctrl-C to quit)Ta5d6ff"

Tb4b4b4)

T8b949e# We enter a loop that runs until the users exits.

T8b949e# If the user hits enter, we will announce our server

T8b949e# destination on the network, which will let clients

T8b949e# know how to create messages directed towards it.

Tff7b72while Tff7b72TrueTb4b4b4:

Te6edf3entered Tff7b72= Tffa657inputTb4b4b4(Tb4b4b4)

Te6edf3destinationTff7b72.Td2a8ffannounceTb4b4b4(Tb4b4b4)

Te6edf3RNSTff7b72.Td2a8fflogTb4b4b4(Ta5d6ff"Ta5d6ffSent announce from Ta5d6ff"Tff7b72+Te6edf3RNSTff7b72.Td2a8ffprettyhexrepTb4b4b4(Te6edf3destinationTff7b72.Td2a8ffhashTb4b4b4)Tb4b4b4)

T8b949e##########################################################

T8b949e#### Program Startup #####################################

T8b949e##########################################################

T8b949e# This part of the program gets run at startup,

T8b949e# and parses input from the user, and then starts

T8b949e# the desired program mode.

Tff7b72if Tff7b72__name__ Tff7b72== Ta5d6ff"Ta5d6ff__main__Ta5d6ff"Tb4b4b4:

Tff7b72tryTb4b4b4:

Te6edf3parser Tff7b72= Te6edf3argparseTff7b72.Td2a8ffArgumentParserTb4b4b4(

Te6edf3descriptionTff7b72=Ta5d6ff"Ta5d6ffMinimal example to start Reticulum and create a destinationTa5d6ff"

Tb4b4b4)

Te6edf3parserTff7b72.Td2a8ffadd_argumentTb4b4b4(

Ta5d6ff"Ta5d6ff--configTa5d6ff"Tb4b4b4,

Te6edf3actionTff7b72=Ta5d6ff"Ta5d6ffstoreTa5d6ff"Tb4b4b4,

Te6edf3defaultTff7b72=Tff7b72NoneTb4b4b4,

Te6edf3helpTff7b72=Ta5d6ff"Ta5d6ffpath to alternative Reticulum config directoryTa5d6ff"Tb4b4b4,

Tffa657typeTff7b72=Tffa657str

Tb4b4b4)

Te6edf3args Tff7b72= Te6edf3parserTff7b72.Td2a8ffparse_argsTb4b4b4(Tb4b4b4)

Tff7b72if Te6edf3argsTff7b72.Td2a8ffconfigTb4b4b4:

Te6edf3configarg Tff7b72= Te6edf3argsTff7b72.Td2a8ffconfig

Tff7b72elseTb4b4b4:

Te6edf3configarg Tff7b72= Tff7b72None

Te6edf3program_setupTb4b4b4(Te6edf3configargTb4b4b4)

Tff7b72except Tf85149KeyboardInterruptTb4b4b4:

Tffa657printTb4b4b4(Ta5d6ff"Ta5d6ff"Tb4b4b4)

Te6edf3sysTff7b72.Td2a8ffexitTb4b4b4(T79c0ff0Tb4b4b4)

This example can also be found at https://github.com/markqvist/Reticulum/blob/master/Examples/Minimal.py.

Announce

The Announce example builds upon the previous example by exploring how to announce a destination on the network, and how to let your program receive notifications about announces from relevant destinations.

T282828

T8b949e##########################################################

T8b949e# This RNS example demonstrates setting up announce #

T8b949e# callbacks, which will let an application receive a #

T8b949e# notification when an announce relevant for it arrives #

T8b949e##########################################################

Tff7b72import T7ee787argparse

Tff7b72import T7ee787random

Tff7b72import T7ee787sys

Tff7b72import T7ee787RNS

T8b949e# Let's define an app name. We'll use this for all

T8b949e# destinations we create. Since this basic example

T8b949e# is part of a range of example utilities, we'll put

T8b949e# them all within the app namespace "example_utilities"

Te6edf3APP_NAME Tff7b72= Ta5d6ff"Ta5d6ffexample_utilitiesTa5d6ff"

T8b949e# We initialise two lists of strings to use as app_data

Te6edf3fruits Tff7b72= Tb4b4b4[Ta5d6ff"Ta5d6ffPeachTa5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ffQuinceTa5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ffDateTa5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ffTangerineTa5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ffPomeloTa5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ffCarambolaTa5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ffGrapeTa5d6ff"Tb4b4b4]

Te6edf3noble_gases Tff7b72= Tb4b4b4[Ta5d6ff"Ta5d6ffHeliumTa5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ffNeonTa5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ffArgonTa5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ffKryptonTa5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ffXenonTa5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ffRadonTa5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ffOganessonTa5d6ff"Tb4b4b4]

T8b949e# This initialisation is executed when the program is started

Tff7b72def Td2a8ffprogram_setupTb4b4b4(Te6edf3configpathTb4b4b4)Tb4b4b4:

T8b949e# We must first initialise Reticulum

Te6edf3reticulum Tff7b72= Te6edf3RNSTff7b72.Td2a8ffReticulumTb4b4b4(Te6edf3configpathTb4b4b4)

T8b949e# Randomly create a new identity for our example

Te6edf3identity Tff7b72= Te6edf3RNSTff7b72.Td2a8ffIdentityTb4b4b4(Tb4b4b4)

T8b949e# Using the identity we just created, we create two destinations

T8b949e# in the "example_utilities.announcesample" application space.

T8b949e#

T8b949e# Destinations are endpoints in Reticulum, that can be addressed

T8b949e# and communicated with. Destinations can also announce their

T8b949e# existence, which will let the network know they are reachable

T8b949e# and automatically create paths to them, from anywhere else

T8b949e# in the network.

Te6edf3destination_1 Tff7b72= Te6edf3RNSTff7b72.Td2a8ffDestinationTb4b4b4(

Te6edf3identityTb4b4b4,

Te6edf3RNSTff7b72.Td2a8ffDestinationTff7b72.Td2a8ffINTb4b4b4,

Te6edf3RNSTff7b72.Td2a8ffDestinationTff7b72.Td2a8ffSINGLETb4b4b4,

Te6edf3APP_NAMETb4b4b4,

Ta5d6ff"Ta5d6ffannouncesampleTa5d6ff"Tb4b4b4,

Ta5d6ff"Ta5d6fffruitsTa5d6ff"

Tb4b4b4)

Te6edf3destination_2 Tff7b72= Te6edf3RNSTff7b72.Td2a8ffDestinationTb4b4b4(

Te6edf3identityTb4b4b4,

Te6edf3RNSTff7b72.Td2a8ffDestinationTff7b72.Td2a8ffINTb4b4b4,

Te6edf3RNSTff7b72.Td2a8ffDestinationTff7b72.Td2a8ffSINGLETb4b4b4,

Te6edf3APP_NAMETb4b4b4,

Ta5d6ff"Ta5d6ffannouncesampleTa5d6ff"Tb4b4b4,

Ta5d6ff"Ta5d6ffnoble_gasesTa5d6ff"

Tb4b4b4)

T8b949e# We configure the destinations to automatically prove all

T8b949e# packets addressed to it. By doing this, RNS will automatically

T8b949e# generate a proof for each incoming packet and transmit it

T8b949e# back to the sender of that packet. This will let anyone that

T8b949e# tries to communicate with the destination know whether their

T8b949e# communication was received correctly.

Te6edf3destination_1Tff7b72.Td2a8ffset_proof_strategyTb4b4b4(Te6edf3RNSTff7b72.Td2a8ffDestinationTff7b72.Td2a8ffPROVE_ALLTb4b4b4)

Te6edf3destination_2Tff7b72.Td2a8ffset_proof_strategyTb4b4b4(Te6edf3RNSTff7b72.Td2a8ffDestinationTff7b72.Td2a8ffPROVE_ALLTb4b4b4)

T8b949e# We create an announce handler and configure it to only ask for

T8b949e# announces from "example_utilities.announcesample.fruits".

T8b949e# Try changing the filter and see what happens.

Te6edf3announce_handler Tff7b72= Te6edf3ExampleAnnounceHandlerTb4b4b4(

Te6edf3aspect_filterTff7b72=Ta5d6ff"Ta5d6ffexample_utilities.announcesample.fruitsTa5d6ff"

Tb4b4b4)

T8b949e# We register the announce handler with Reticulum

Te6edf3RNSTff7b72.Td2a8ffTransportTff7b72.Td2a8ffregister_announce_handlerTb4b4b4(Te6edf3announce_handlerTb4b4b4)

T8b949e# Everything's ready!

T8b949e# Let's hand over control to the announce loop

Te6edf3announceLoopTb4b4b4(Te6edf3destination_1Tb4b4b4, Te6edf3destination_2Tb4b4b4)

Tff7b72def Td2a8ffannounceLoopTb4b4b4(Te6edf3destination_1Tb4b4b4, Te6edf3destination_2Tb4b4b4)Tb4b4b4:

T8b949e# Let the user know that everything is ready

Te6edf3RNSTff7b72.Td2a8fflogTb4b4b4(Ta5d6ff"Ta5d6ffAnnounce example running, hit enter to manually send an announce (Ctrl-C to quit)Ta5d6ff"Tb4b4b4)

T8b949e# We enter a loop that runs until the users exits.

T8b949e# If the user hits enter, we will announce our server

T8b949e# destination on the network, which will let clients

T8b949e# know how to create messages directed towards it.

Tff7b72while Tff7b72TrueTb4b4b4:

Te6edf3entered Tff7b72= Tffa657inputTb4b4b4(Tb4b4b4)

T8b949e# Randomly select a fruit

Te6edf3fruit Tff7b72= Te6edf3fruitsTb4b4b4[Te6edf3randomTff7b72.Td2a8ffrandintTb4b4b4(T79c0ff0Tb4b4b4,Tffa657lenTb4b4b4(Te6edf3fruitsTb4b4b4)Tff7b72-T79c0ff1Tb4b4b4)Tb4b4b4]

T8b949e# Send the announce including the app data

Te6edf3destination_1Tff7b72.Td2a8ffannounceTb4b4b4(Te6edf3app_dataTff7b72=Te6edf3fruitTff7b72.Td2a8ffencodeTb4b4b4(Ta5d6ff"Ta5d6ffutf-8Ta5d6ff"Tb4b4b4)Tb4b4b4)

Te6edf3RNSTff7b72.Td2a8fflogTb4b4b4(

Ta5d6ff"Ta5d6ffSent announce from Ta5d6ff"Tff7b72+

Te6edf3RNSTff7b72.Td2a8ffprettyhexrepTb4b4b4(Te6edf3destination_1Tff7b72.Td2a8ffhashTb4b4b4)Tff7b72+

Ta5d6ff"Ta5d6ff (Ta5d6ff"Tff7b72+Te6edf3destination_1Tff7b72.Td2a8ffnameTff7b72+Ta5d6ff"Ta5d6ff)Ta5d6ff"

Tb4b4b4)

T8b949e# Randomly select a noble gas

Te6edf3noble_gas Tff7b72= Te6edf3noble_gasesTb4b4b4[Te6edf3randomTff7b72.Td2a8ffrandintTb4b4b4(T79c0ff0Tb4b4b4,Tffa657lenTb4b4b4(Te6edf3noble_gasesTb4b4b4)Tff7b72-T79c0ff1Tb4b4b4)Tb4b4b4]

T8b949e# Send the announce including the app data

Te6edf3destination_2Tff7b72.Td2a8ffannounceTb4b4b4(Te6edf3app_dataTff7b72=Te6edf3noble_gasTff7b72.Td2a8ffencodeTb4b4b4(Ta5d6ff"Ta5d6ffutf-8Ta5d6ff"Tb4b4b4)Tb4b4b4)

Te6edf3RNSTff7b72.Td2a8fflogTb4b4b4(

Ta5d6ff"Ta5d6ffSent announce from Ta5d6ff"Tff7b72+

Te6edf3RNSTff7b72.Td2a8ffprettyhexrepTb4b4b4(Te6edf3destination_2Tff7b72.Td2a8ffhashTb4b4b4)Tff7b72+

Ta5d6ff"Ta5d6ff (Ta5d6ff"Tff7b72+Te6edf3destination_2Tff7b72.Td2a8ffnameTff7b72+Ta5d6ff"Ta5d6ff)Ta5d6ff"

Tb4b4b4)

T8b949e# We will need to define an announce handler class that

T8b949e# Reticulum can message when an announce arrives.

Tff7b72class T56d364ExampleAnnounceHandlerTb4b4b4:

T8b949e# The initialisation method takes the optional

T8b949e# aspect_filter argument. If aspect_filter is set to

T8b949e# None, all announces will be passed to the instance.

T8b949e# If only some announces are wanted, it can be set to

T8b949e# an aspect string.

Tff7b72def Tff7b72__init__Tb4b4b4(Tff7b72selfTb4b4b4, Te6edf3aspect_filterTff7b72=Tff7b72NoneTb4b4b4)Tb4b4b4:

Tff7b72selfTff7b72.Td2a8ffaspect_filter Tff7b72= Te6edf3aspect_filter

T8b949e# This method will be called by Reticulums Transport

T8b949e# system when an announce arrives that matches the

T8b949e# configured aspect filter. Filters must be specific,

T8b949e# and cannot use wildcards.

Tff7b72def Td2a8ffreceived_announceTb4b4b4(Tff7b72selfTb4b4b4, Te6edf3destination_hashTb4b4b4, Te6edf3announced_identityTb4b4b4, Te6edf3app_dataTb4b4b4)Tb4b4b4:

Te6edf3RNSTff7b72.Td2a8fflogTb4b4b4(

Ta5d6ff"Ta5d6ffReceived an announce from Ta5d6ff"Tff7b72+

Te6edf3RNSTff7b72.Td2a8ffprettyhexrepTb4b4b4(Te6edf3destination_hashTb4b4b4)

Tb4b4b4)

Tff7b72if Te6edf3app_dataTb4b4b4:

Te6edf3RNSTff7b72.Td2a8fflogTb4b4b4(

Ta5d6ff"Ta5d6ffThe announce contained the following app data: Ta5d6ff"Tff7b72+

Te6edf3app_dataTff7b72.Td2a8ffdecodeTb4b4b4(Ta5d6ff"Ta5d6ffutf-8Ta5d6ff"Tb4b4b4)

Tb4b4b4)

T8b949e##########################################################

T8b949e#### Program Startup #####################################

T8b949e##########################################################

T8b949e# This part of the program gets run at startup,

T8b949e# and parses input from the user, and then starts

T8b949e# the desired program mode.

Tff7b72if Tff7b72__name__ Tff7b72== Ta5d6ff"Ta5d6ff__main__Ta5d6ff"Tb4b4b4:

Tff7b72tryTb4b4b4:

Te6edf3parser Tff7b72= Te6edf3argparseTff7b72.Td2a8ffArgumentParserTb4b4b4(

Te6edf3descriptionTff7b72=Ta5d6ff"Ta5d6ffReticulum example that demonstrates announces and announce handlersTa5d6ff"

Tb4b4b4)

Te6edf3parserTff7b72.Td2a8ffadd_argumentTb4b4b4(

Ta5d6ff"Ta5d6ff--configTa5d6ff"Tb4b4b4,

Te6edf3actionTff7b72=Ta5d6ff"Ta5d6ffstoreTa5d6ff"Tb4b4b4,

Te6edf3defaultTff7b72=Tff7b72NoneTb4b4b4,

Te6edf3helpTff7b72=Ta5d6ff"Ta5d6ffpath to alternative Reticulum config directoryTa5d6ff"Tb4b4b4,

Tffa657typeTff7b72=Tffa657str

Tb4b4b4)

Te6edf3args Tff7b72= Te6edf3parserTff7b72.Td2a8ffparse_argsTb4b4b4(Tb4b4b4)

Tff7b72if Te6edf3argsTff7b72.Td2a8ffconfigTb4b4b4:

Te6edf3configarg Tff7b72= Te6edf3argsTff7b72.Td2a8ffconfig

Tff7b72elseTb4b4b4:

Te6edf3configarg Tff7b72= Tff7b72None

Te6edf3program_setupTb4b4b4(Te6edf3configargTb4b4b4)

Tff7b72except Tf85149KeyboardInterruptTb4b4b4:

Tffa657printTb4b4b4(Ta5d6ff"Ta5d6ff"Tb4b4b4)

Te6edf3sysTff7b72.Td2a8ffexitTb4b4b4(T79c0ff0Tb4b4b4)

This example can also be found at https://github.com/markqvist/Reticulum/blob/master/Examples/Announce.py.

Broadcast

The Broadcast example explores how to transmit plaintext broadcast messages over the network.

T282828

T8b949e##########################################################

T8b949e# This RNS example demonstrates broadcasting unencrypted #

T8b949e# information to any listening destinations. #

T8b949e##########################################################

Tff7b72import T7ee787sys

Tff7b72import T7ee787argparse

Tff7b72import T7ee787RNS

T8b949e# Let's define an app name. We'll use this for all

T8b949e# destinations we create. Since this basic example

T8b949e# is part of a range of example utilities, we'll put

T8b949e# them all within the app namespace "example_utilities"

Te6edf3APP_NAME Tff7b72= Ta5d6ff"Ta5d6ffexample_utilitiesTa5d6ff"

T8b949e# This initialisation is executed when the program is started

Tff7b72def Td2a8ffprogram_setupTb4b4b4(Te6edf3configpathTb4b4b4, Te6edf3channelTff7b72=Tff7b72NoneTb4b4b4)Tb4b4b4:

T8b949e# We must first initialise Reticulum

Te6edf3reticulum Tff7b72= Te6edf3RNSTff7b72.Td2a8ffReticulumTb4b4b4(Te6edf3configpathTb4b4b4)

T8b949e# If the user did not select a "channel" we use

T8b949e# a default one called "public_information".

T8b949e# This "channel" is added to the destination name-

T8b949e# space, so the user can select different broadcast

T8b949e# channels.

Tff7b72if Te6edf3channel Tff7b72== Tff7b72NoneTb4b4b4:

Te6edf3channel Tff7b72= Ta5d6ff"Ta5d6ffpublic_informationTa5d6ff"

T8b949e# We create a PLAIN destination. This is an uncencrypted endpoint

T8b949e# that anyone can listen to and send information to.

Te6edf3broadcast_destination Tff7b72= Te6edf3RNSTff7b72.Td2a8ffDestinationTb4b4b4(

Tff7b72NoneTb4b4b4,

Te6edf3RNSTff7b72.Td2a8ffDestinationTff7b72.Td2a8ffINTb4b4b4,

Te6edf3RNSTff7b72.Td2a8ffDestinationTff7b72.Td2a8ffPLAINTb4b4b4,

Te6edf3APP_NAMETb4b4b4,

Ta5d6ff"Ta5d6ffbroadcastTa5d6ff"Tb4b4b4,

Te6edf3channel

Tb4b4b4)

T8b949e# We specify a callback that will get called every time

T8b949e# the destination receives data.

Te6edf3broadcast_destinationTff7b72.Td2a8ffset_packet_callbackTb4b4b4(Te6edf3packet_callbackTb4b4b4)

T8b949e# Everything's ready!

T8b949e# Let's hand over control to the main loop

Te6edf3broadcastLoopTb4b4b4(Te6edf3broadcast_destinationTb4b4b4)

Tff7b72def Td2a8ffpacket_callbackTb4b4b4(Te6edf3dataTb4b4b4, Te6edf3packetTb4b4b4)Tb4b4b4:

T8b949e# Simply print out the received data

Tffa657printTb4b4b4(Ta5d6ff"Ta5d6ff"Tb4b4b4)

Tffa657printTb4b4b4(Ta5d6ff"Ta5d6ffReceived data: Ta5d6ff"Tff7b72+Te6edf3dataTff7b72.Td2a8ffdecodeTb4b4b4(Ta5d6ff"Ta5d6ffutf-8Ta5d6ff"Tb4b4b4)Tff7b72+Ta5d6ff"Tffea00\rTffea00\nTa5d6ff> Ta5d6ff"Tb4b4b4, Te6edf3endTff7b72=Ta5d6ff"Ta5d6ff"Tb4b4b4)

Te6edf3sysTff7b72.Td2a8ffstdoutTff7b72.Td2a8ffflushTb4b4b4(Tb4b4b4)

Tff7b72def Td2a8ffbroadcastLoopTb4b4b4(Te6edf3destinationTb4b4b4)Tb4b4b4:

T8b949e# Let the user know that everything is ready

Te6edf3RNSTff7b72.Td2a8fflogTb4b4b4(

Ta5d6ff"Ta5d6ffBroadcast example Ta5d6ff"Tff7b72+

Te6edf3RNSTff7b72.Td2a8ffprettyhexrepTb4b4b4(Te6edf3destinationTff7b72.Td2a8ffhashTb4b4b4)Tff7b72+

Ta5d6ff"Ta5d6ff running, enter text and hit enter to broadcast (Ctrl-C to quit)Ta5d6ff"

Tb4b4b4)

T8b949e# We enter a loop that runs until the users exits.

T8b949e# If the user hits enter, we will send the information

T8b949e# that the user entered into the prompt.

Tff7b72while Tff7b72TrueTb4b4b4:

Tffa657printTb4b4b4(Ta5d6ff"Ta5d6ff> Ta5d6ff"Tb4b4b4, Te6edf3endTff7b72=Ta5d6ff"Ta5d6ff"Tb4b4b4)

Te6edf3entered Tff7b72= Tffa657inputTb4b4b4(Tb4b4b4)

Tff7b72if Te6edf3entered Tff7b72!= Ta5d6ff"Ta5d6ff"Tb4b4b4:

Te6edf3data Tff7b72= Te6edf3enteredTff7b72.Td2a8ffencodeTb4b4b4(Ta5d6ff"Ta5d6ffutf-8Ta5d6ff"Tb4b4b4)

Te6edf3packet Tff7b72= Te6edf3RNSTff7b72.Td2a8ffPacketTb4b4b4(Te6edf3destinationTb4b4b4, Te6edf3dataTb4b4b4)

Te6edf3packetTff7b72.Td2a8ffsendTb4b4b4(Tb4b4b4)

T8b949e##########################################################

T8b949e#### Program Startup #####################################

T8b949e##########################################################

T8b949e# This part of the program gets run at startup,

T8b949e# and parses input from the user, and then starts

T8b949e# the program.

Tff7b72if Tff7b72__name__ Tff7b72== Ta5d6ff"Ta5d6ff__main__Ta5d6ff"Tb4b4b4:

Tff7b72tryTb4b4b4:

Te6edf3parser Tff7b72= Te6edf3argparseTff7b72.Td2a8ffArgumentParserTb4b4b4(

Te6edf3descriptionTff7b72=Ta5d6ff"Ta5d6ffReticulum example demonstrating sending and receiving broadcastsTa5d6ff"

Tb4b4b4)

Te6edf3parserTff7b72.Td2a8ffadd_argumentTb4b4b4(

Ta5d6ff"Ta5d6ff--configTa5d6ff"Tb4b4b4,

Te6edf3actionTff7b72=Ta5d6ff"Ta5d6ffstoreTa5d6ff"Tb4b4b4,

Te6edf3defaultTff7b72=Tff7b72NoneTb4b4b4,

Te6edf3helpTff7b72=Ta5d6ff"Ta5d6ffpath to alternative Reticulum config directoryTa5d6ff"Tb4b4b4,

Tffa657typeTff7b72=Tffa657str

Tb4b4b4)

Te6edf3parserTff7b72.Td2a8ffadd_argumentTb4b4b4(

Ta5d6ff"Ta5d6ff--channelTa5d6ff"Tb4b4b4,

Te6edf3actionTff7b72=Ta5d6ff"Ta5d6ffstoreTa5d6ff"Tb4b4b4,

Te6edf3defaultTff7b72=Tff7b72NoneTb4b4b4,

Te6edf3helpTff7b72=Ta5d6ff"Ta5d6ffbroadcast channel nameTa5d6ff"Tb4b4b4,

Tffa657typeTff7b72=Tffa657str

Tb4b4b4)

Te6edf3args Tff7b72= Te6edf3parserTff7b72.Td2a8ffparse_argsTb4b4b4(Tb4b4b4)

Tff7b72if Te6edf3argsTff7b72.Td2a8ffconfigTb4b4b4:

Te6edf3configarg Tff7b72= Te6edf3argsTff7b72.Td2a8ffconfig

Tff7b72elseTb4b4b4:

Te6edf3configarg Tff7b72= Tff7b72None

Tff7b72if Te6edf3argsTff7b72.Td2a8ffchannelTb4b4b4:

Te6edf3channelarg Tff7b72= Te6edf3argsTff7b72.Td2a8ffchannel

Tff7b72elseTb4b4b4:

Te6edf3channelarg Tff7b72= Tff7b72None

Te6edf3program_setupTb4b4b4(Te6edf3configargTb4b4b4, Te6edf3channelargTb4b4b4)

Tff7b72except Tf85149KeyboardInterruptTb4b4b4:

Tffa657printTb4b4b4(Ta5d6ff"Ta5d6ff"Tb4b4b4)

Te6edf3sysTff7b72.Td2a8ffexitTb4b4b4(T79c0ff0Tb4b4b4)

This example can also be found at https://github.com/markqvist/Reticulum/blob/master/Examples/Broadcast.py.

Echo

The Echo example demonstrates communication between two destinations using the Packet interface.

T282828

T8b949e##########################################################

T8b949e# This RNS example demonstrates a simple client/server #

T8b949e# echo utility. A client can send an echo request to the #

T8b949e# server, and the server will respond by proving receipt #

T8b949e# of the packet. #

T8b949e##########################################################

Tff7b72import T7ee787argparse

Tff7b72import T7ee787sys

Tff7b72import T7ee787RNS

T8b949e# Let's define an app name. We'll use this for all

T8b949e# destinations we create. Since this echo example

T8b949e# is part of a range of example utilities, we'll put

T8b949e# them all within the app namespace "example_utilities"

Te6edf3APP_NAME Tff7b72= Ta5d6ff"Ta5d6ffexample_utilitiesTa5d6ff"

T8b949e##########################################################

T8b949e#### Server Part #########################################

T8b949e##########################################################

T8b949e# This initialisation is executed when the users chooses

T8b949e# to run as a server

Tff7b72def Td2a8ffserverTb4b4b4(Te6edf3configpathTb4b4b4)Tb4b4b4:

Tff7b72global Te6edf3reticulum

T8b949e# We must first initialise Reticulum

Te6edf3reticulum Tff7b72= Te6edf3RNSTff7b72.Td2a8ffReticulumTb4b4b4(Te6edf3configpathTb4b4b4)

T8b949e# Randomly create a new identity for our echo server

Te6edf3server_identity Tff7b72= Te6edf3RNSTff7b72.Td2a8ffIdentityTb4b4b4(Tb4b4b4)

T8b949e# We create a destination that clients can query. We want

T8b949e# to be able to verify echo replies to our clients, so we

T8b949e# create a "single" destination that can receive encrypted

T8b949e# messages. This way the client can send a request and be

T8b949e# certain that no-one else than this destination was able

T8b949e# to read it.

Te6edf3echo_destination Tff7b72= Te6edf3RNSTff7b72.Td2a8ffDestinationTb4b4b4(

Te6edf3server_identityTb4b4b4,

Te6edf3RNSTff7b72.Td2a8ffDestinationTff7b72.Td2a8ffINTb4b4b4,

Te6edf3RNSTff7b72.Td2a8ffDestinationTff7b72.Td2a8ffSINGLETb4b4b4,

Te6edf3APP_NAMETb4b4b4,

Ta5d6ff"Ta5d6ffechoTa5d6ff"Tb4b4b4,

Ta5d6ff"Ta5d6ffrequestTa5d6ff"

Tb4b4b4)

T8b949e# We configure the destination to automatically prove all

T8b949e# packets addressed to it. By doing this, RNS will automatically

T8b949e# generate a proof for each incoming packet and transmit it

T8b949e# back to the sender of that packet.

Te6edf3echo_destinationTff7b72.Td2a8ffset_proof_strategyTb4b4b4(Te6edf3RNSTff7b72.Td2a8ffDestinationTff7b72.Td2a8ffPROVE_ALLTb4b4b4)

T8b949e# Tell the destination which function in our program to

T8b949e# run when a packet is received. We do this so we can

T8b949e# print a log message when the server receives a request

Te6edf3echo_destinationTff7b72.Td2a8ffset_packet_callbackTb4b4b4(Te6edf3server_callbackTb4b4b4)

T8b949e# Everything's ready!

T8b949e# Let's Wait for client requests or user input

Te6edf3announceLoopTb4b4b4(Te6edf3echo_destinationTb4b4b4)

Tff7b72def Td2a8ffannounceLoopTb4b4b4(Te6edf3destinationTb4b4b4)Tb4b4b4:

T8b949e# Let the user know that everything is ready

Te6edf3RNSTff7b72.Td2a8fflogTb4b4b4(

Ta5d6ff"Ta5d6ffEcho server Ta5d6ff"Tff7b72+

Te6edf3RNSTff7b72.Td2a8ffprettyhexrepTb4b4b4(Te6edf3destinationTff7b72.Td2a8ffhashTb4b4b4)Tff7b72+

Ta5d6ff"Ta5d6ff running, hit enter to manually send an announce (Ctrl-C to quit)Ta5d6ff"

Tb4b4b4)

T8b949e# We enter a loop that runs until the users exits.

T8b949e# If the user hits enter, we will announce our server

T8b949e# destination on the network, which will let clients

T8b949e# know how to create messages directed towards it.

Tff7b72while Tff7b72TrueTb4b4b4:

Te6edf3entered Tff7b72= Tffa657inputTb4b4b4(Tb4b4b4)

Te6edf3destinationTff7b72.Td2a8ffannounceTb4b4b4(Tb4b4b4)

Te6edf3RNSTff7b72.Td2a8fflogTb4b4b4(Ta5d6ff"Ta5d6ffSent announce from Ta5d6ff"Tff7b72+Te6edf3RNSTff7b72.Td2a8ffprettyhexrepTb4b4b4(Te6edf3destinationTff7b72.Td2a8ffhashTb4b4b4)Tb4b4b4)

Tff7b72def Td2a8ffserver_callbackTb4b4b4(Te6edf3messageTb4b4b4, Te6edf3packetTb4b4b4)Tb4b4b4:

Tff7b72global Te6edf3reticulum

T8b949e# Tell the user that we received an echo request, and

T8b949e# that we are going to send a reply to the requester.

T8b949e# Sending the proof is handled automatically, since we

T8b949e# set up the destination to prove all incoming packets.

Te6edf3reception_stats Tff7b72= Ta5d6ff"Ta5d6ff"

Tff7b72if Te6edf3reticulumTff7b72.Td2a8ffis_connected_to_shared_instanceTb4b4b4:

Te6edf3reception_rssi Tff7b72= Te6edf3reticulumTff7b72.Td2a8ffget_packet_rssiTb4b4b4(Te6edf3packetTff7b72.Td2a8ffpacket_hashTb4b4b4)

Te6edf3reception_snr Tff7b72= Te6edf3reticulumTff7b72.Td2a8ffget_packet_snrTb4b4b4(Te6edf3packetTff7b72.Td2a8ffpacket_hashTb4b4b4)

Tff7b72if Te6edf3reception_rssi Tff7b72!= Tff7b72NoneTb4b4b4:

Te6edf3reception_stats Tff7b72+Tff7b72= Ta5d6ff"Ta5d6ff [RSSI Ta5d6ff"Tff7b72+Tffa657strTb4b4b4(Te6edf3reception_rssiTb4b4b4)Tff7b72+Ta5d6ff"Ta5d6ff dBm]Ta5d6ff"

Tff7b72if Te6edf3reception_snr Tff7b72!= Tff7b72NoneTb4b4b4:

Te6edf3reception_stats Tff7b72+Tff7b72= Ta5d6ff"Ta5d6ff [SNR Ta5d6ff"Tff7b72+Tffa657strTb4b4b4(Te6edf3reception_snrTb4b4b4)Tff7b72+Ta5d6ff"Ta5d6ff dBm]Ta5d6ff"

Tff7b72elseTb4b4b4:

Tff7b72if Te6edf3packetTff7b72.Td2a8ffrssi Tff7b72!= Tff7b72NoneTb4b4b4:

Te6edf3reception_stats Tff7b72+Tff7b72= Ta5d6ff"Ta5d6ff [RSSI Ta5d6ff"Tff7b72+Tffa657strTb4b4b4(Te6edf3packetTff7b72.Td2a8ffrssiTb4b4b4)Tff7b72+Ta5d6ff"Ta5d6ff dBm]Ta5d6ff"

Tff7b72if Te6edf3packetTff7b72.Td2a8ffsnr Tff7b72!= Tff7b72NoneTb4b4b4:

Te6edf3reception_stats Tff7b72+Tff7b72= Ta5d6ff"Ta5d6ff [SNR Ta5d6ff"Tff7b72+Tffa657strTb4b4b4(Te6edf3packetTff7b72.Td2a8ffsnrTb4b4b4)Tff7b72+Ta5d6ff"Ta5d6ff dB]Ta5d6ff"

Te6edf3RNSTff7b72.Td2a8fflogTb4b4b4(Ta5d6ff"Ta5d6ffReceived packet from echo client, proof sentTa5d6ff"Tff7b72+Te6edf3reception_statsTb4b4b4)

T8b949e##########################################################

T8b949e#### Client Part #########################################

T8b949e##########################################################

T8b949e# This initialisation is executed when the users chooses

T8b949e# to run as a client

Tff7b72def Td2a8ffclientTb4b4b4(Te6edf3destination_hexhashTb4b4b4, Te6edf3configpathTb4b4b4, Te6edf3timeoutTff7b72=Tff7b72NoneTb4b4b4)Tb4b4b4:

Tff7b72global Te6edf3reticulum

T8b949e# We need a binary representation of the destination

T8b949e# hash that was entered on the command line

Tff7b72tryTb4b4b4:

Te6edf3dest_len Tff7b72= Tb4b4b4(Te6edf3RNSTff7b72.Td2a8ffReticulumTff7b72.Td2a8ffTRUNCATED_HASHLENGTHTff7b72/Tff7b72/T79c0ff8Tb4b4b4)Tff7b72*T79c0ff2

Tff7b72if Tffa657lenTb4b4b4(Te6edf3destination_hexhashTb4b4b4) Tff7b72!= Te6edf3dest_lenTb4b4b4:

Tff7b72raise Tf85149ValueErrorTb4b4b4(

Ta5d6ff"Ta5d6ffDestination length is invalid, must be Tffd700{hex}Ta5d6ff hexadecimal characters (Tffd700{byte}Ta5d6ff bytes).Ta5d6ff"Tff7b72.Td2a8ffformatTb4b4b4(Tffa657hexTff7b72=Te6edf3dest_lenTb4b4b4, Te6edf3byteTff7b72=Te6edf3dest_lenTff7b72/Tff7b72/T79c0ff2Tb4b4b4)

Tb4b4b4)

Te6edf3destination_hash Tff7b72= Tffa657bytesTff7b72.Td2a8fffromhexTb4b4b4(Te6edf3destination_hexhashTb4b4b4)

Tff7b72except Tf85149Exception Tff7b72as Te6edf3eTb4b4b4:

Te6edf3RNSTff7b72.Td2a8fflogTb4b4b4(Ta5d6ff"Ta5d6ffInvalid destination entered. Check your input!Ta5d6ff"Tb4b4b4)

Te6edf3RNSTff7b72.Td2a8fflogTb4b4b4(Tffa657strTb4b4b4(Te6edf3eTb4b4b4)Tff7b72+Ta5d6ff"Tffea00\nTa5d6ff"Tb4b4b4)

Te6edf3sysTff7b72.Td2a8ffexitTb4b4b4(T79c0ff0Tb4b4b4)

T8b949e# We must first initialise Reticulum

Te6edf3reticulum Tff7b72= Te6edf3RNSTff7b72.Td2a8ffReticulumTb4b4b4(Te6edf3configpathTb4b4b4)

T8b949e# We override the loglevel to provide feedback when

T8b949e# an announce is received

Tff7b72if Te6edf3RNSTff7b72.Td2a8ffloglevel Tff7b72< Te6edf3RNSTff7b72.Td2a8ffLOG_INFOTb4b4b4:

Te6edf3RNSTff7b72.Td2a8ffloglevel Tff7b72= Te6edf3RNSTff7b72.Td2a8ffLOG_INFO

T8b949e# Tell the user that the client is ready!

Te6edf3RNSTff7b72.Td2a8fflogTb4b4b4(

Ta5d6ff"Ta5d6ffEcho client ready, hit enter to send echo request to Ta5d6ff"Tff7b72+

Te6edf3destination_hexhashTff7b72+

Ta5d6ff"Ta5d6ff (Ctrl-C to quit)Ta5d6ff"

Tb4b4b4)

T8b949e# We enter a loop that runs until the user exits.

T8b949e# If the user hits enter, we will try to send an

T8b949e# echo request to the destination specified on the

T8b949e# command line.

Tff7b72while Tff7b72TrueTb4b4b4:

Tffa657inputTb4b4b4(Tb4b4b4)

T8b949e# Let's first check if RNS knows a path to the destination.

T8b949e# If it does, we'll load the server identity and create a packet

Tff7b72if Te6edf3RNSTff7b72.Td2a8ffTransportTff7b72.Td2a8ffhas_pathTb4b4b4(Te6edf3destination_hashTb4b4b4)Tb4b4b4:

T8b949e# To address the server, we need to know it's public

T8b949e# key, so we check if Reticulum knows this destination.

T8b949e# This is done by calling the "recall" method of the

T8b949e# Identity module. If the destination is known, it will

T8b949e# return an Identity instance that can be used in

T8b949e# outgoing destinations.

Te6edf3server_identity Tff7b72= Te6edf3RNSTff7b72.Td2a8ffIdentityTff7b72.Td2a8ffrecallTb4b4b4(Te6edf3destination_hashTb4b4b4)

T8b949e# We got the correct identity instance from the

T8b949e# recall method, so let's create an outgoing

T8b949e# destination. We use the naming convention:

T8b949e# example_utilities.echo.request

T8b949e# This matches the naming we specified in the

T8b949e# server part of the code.

Te6edf3request_destination Tff7b72= Te6edf3RNSTff7b72.Td2a8ffDestinationTb4b4b4(

Te6edf3server_identityTb4b4b4,

Te6edf3RNSTff7b72.Td2a8ffDestinationTff7b72.Td2a8ffOUTTb4b4b4,

Te6edf3RNSTff7b72.Td2a8ffDestinationTff7b72.Td2a8ffSINGLETb4b4b4,

Te6edf3APP_NAMETb4b4b4,

Ta5d6ff"Ta5d6ffechoTa5d6ff"Tb4b4b4,

Ta5d6ff"Ta5d6ffrequestTa5d6ff"

Tb4b4b4)

T8b949e# The destination is ready, so let's create a packet.

T8b949e# We set the destination to the request_destination

T8b949e# that was just created, and the only data we add

T8b949e# is a random hash.

Te6edf3echo_request Tff7b72= Te6edf3RNSTff7b72.Td2a8ffPacketTb4b4b4(Te6edf3request_destinationTb4b4b4, Te6edf3RNSTff7b72.Td2a8ffIdentityTff7b72.Td2a8ffget_random_hashTb4b4b4(Tb4b4b4)Tb4b4b4)

T8b949e# Send the packet! If the packet is successfully

T8b949e# sent, it will return a PacketReceipt instance.

Te6edf3packet_receipt Tff7b72= Te6edf3echo_requestTff7b72.Td2a8ffsendTb4b4b4(Tb4b4b4)

T8b949e# If the user specified a timeout, we set this

T8b949e# timeout on the packet receipt, and configure

T8b949e# a callback function, that will get called if

T8b949e# the packet times out.

Tff7b72if Te6edf3timeout Tff7b72!= Tff7b72NoneTb4b4b4:

Te6edf3packet_receiptTff7b72.Td2a8ffset_timeoutTb4b4b4(Te6edf3timeoutTb4b4b4)

Te6edf3packet_receiptTff7b72.Td2a8ffset_timeout_callbackTb4b4b4(Te6edf3packet_timed_outTb4b4b4)

T8b949e# We can then set a delivery callback on the receipt.

T8b949e# This will get automatically called when a proof for

T8b949e# this specific packet is received from the destination.

Te6edf3packet_receiptTff7b72.Td2a8ffset_delivery_callbackTb4b4b4(Te6edf3packet_deliveredTb4b4b4)

T8b949e# Tell the user that the echo request was sent

Te6edf3RNSTff7b72.Td2a8fflogTb4b4b4(Ta5d6ff"Ta5d6ffSent echo request to Ta5d6ff"Tff7b72+Te6edf3RNSTff7b72.Td2a8ffprettyhexrepTb4b4b4(Te6edf3request_destinationTff7b72.Td2a8ffhashTb4b4b4)Tb4b4b4)

Tff7b72elseTb4b4b4:

T8b949e# If we do not know this destination, tell the

T8b949e# user to wait for an announce to arrive.

Te6edf3RNSTff7b72.Td2a8fflogTb4b4b4(Ta5d6ff"Ta5d6ffDestination is not yet known. Requesting path...Ta5d6ff"Tb4b4b4)

Te6edf3RNSTff7b72.Td2a8fflogTb4b4b4(Ta5d6ff"Ta5d6ffHit enter to manually retry once an announce is received.Ta5d6ff"Tb4b4b4)

Te6edf3RNSTff7b72.Td2a8ffTransportTff7b72.Td2a8ffrequest_pathTb4b4b4(Te6edf3destination_hashTb4b4b4)

T8b949e# This function is called when our reply destination

T8b949e# receives a proof packet.

Tff7b72def Td2a8ffpacket_deliveredTb4b4b4(Te6edf3receiptTb4b4b4)Tb4b4b4:

Tff7b72global Te6edf3reticulum

Tff7b72if Te6edf3receiptTff7b72.Td2a8ffstatus Tff7b72== Te6edf3RNSTff7b72.Td2a8ffPacketReceiptTff7b72.Td2a8ffDELIVEREDTb4b4b4:

Te6edf3rtt Tff7b72= Te6edf3receiptTff7b72.Td2a8ffget_rttTb4b4b4(Tb4b4b4)

Tff7b72if Tb4b4b4(Te6edf3rtt Tff7b72>Tff7b72= T79c0ff1Tb4b4b4)Tb4b4b4:

Te6edf3rtt Tff7b72= Tffa657roundTb4b4b4(Te6edf3rttTb4b4b4, T79c0ff3Tb4b4b4)

Te6edf3rttstring Tff7b72= Tffa657strTb4b4b4(Te6edf3rttTb4b4b4)Tff7b72+Ta5d6ff"Ta5d6ff secondsTa5d6ff"

Tff7b72elseTb4b4b4:

Te6edf3rtt Tff7b72= Tffa657roundTb4b4b4(Te6edf3rttTff7b72*T79c0ff1000Tb4b4b4, T79c0ff3Tb4b4b4)

Te6edf3rttstring Tff7b72= Tffa657strTb4b4b4(Te6edf3rttTb4b4b4)Tff7b72+Ta5d6ff"Ta5d6ff millisecondsTa5d6ff"

Te6edf3reception_stats Tff7b72= Ta5d6ff"Ta5d6ff"

Tff7b72if Te6edf3reticulumTff7b72.Td2a8ffis_connected_to_shared_instanceTb4b4b4:

Te6edf3reception_rssi Tff7b72= Te6edf3reticulumTff7b72.Td2a8ffget_packet_rssiTb4b4b4(Te6edf3receiptTff7b72.Td2a8ffproof_packetTff7b72.Td2a8ffpacket_hashTb4b4b4)

Te6edf3reception_snr Tff7b72= Te6edf3reticulumTff7b72.Td2a8ffget_packet_snrTb4b4b4(Te6edf3receiptTff7b72.Td2a8ffproof_packetTff7b72.Td2a8ffpacket_hashTb4b4b4)

Tff7b72if Te6edf3reception_rssi Tff7b72!= Tff7b72NoneTb4b4b4:

Te6edf3reception_stats Tff7b72+Tff7b72= Ta5d6ff"Ta5d6ff [RSSI Ta5d6ff"Tff7b72+Tffa657strTb4b4b4(Te6edf3reception_rssiTb4b4b4)Tff7b72+Ta5d6ff"Ta5d6ff dBm]Ta5d6ff"

Tff7b72if Te6edf3reception_snr Tff7b72!= Tff7b72NoneTb4b4b4:

Te6edf3reception_stats Tff7b72+Tff7b72= Ta5d6ff"Ta5d6ff [SNR Ta5d6ff"Tff7b72+Tffa657strTb4b4b4(Te6edf3reception_snrTb4b4b4)Tff7b72+Ta5d6ff"Ta5d6ff dB]Ta5d6ff"

Tff7b72elseTb4b4b4:

Tff7b72if Te6edf3receiptTff7b72.Td2a8ffproof_packet Tff7b72!= Tff7b72NoneTb4b4b4:

Tff7b72if Te6edf3receiptTff7b72.Td2a8ffproof_packetTff7b72.Td2a8ffrssi Tff7b72!= Tff7b72NoneTb4b4b4:

Te6edf3reception_stats Tff7b72+Tff7b72= Ta5d6ff"Ta5d6ff [RSSI Ta5d6ff"Tff7b72+Tffa657strTb4b4b4(Te6edf3receiptTff7b72.Td2a8ffproof_packetTff7b72.Td2a8ffrssiTb4b4b4)Tff7b72+Ta5d6ff"Ta5d6ff dBm]Ta5d6ff"

Tff7b72if Te6edf3receiptTff7b72.Td2a8ffproof_packetTff7b72.Td2a8ffsnr Tff7b72!= Tff7b72NoneTb4b4b4:

Te6edf3reception_stats Tff7b72+Tff7b72= Ta5d6ff"Ta5d6ff [SNR Ta5d6ff"Tff7b72+Tffa657strTb4b4b4(Te6edf3receiptTff7b72.Td2a8ffproof_packetTff7b72.Td2a8ffsnrTb4b4b4)Tff7b72+Ta5d6ff"Ta5d6ff dB]Ta5d6ff"

Te6edf3RNSTff7b72.Td2a8fflogTb4b4b4(

Ta5d6ff"Ta5d6ffValid reply received from Ta5d6ff"Tff7b72+

Te6edf3RNSTff7b72.Td2a8ffprettyhexrepTb4b4b4(Te6edf3receiptTff7b72.Td2a8ffdestinationTff7b72.Td2a8ffhashTb4b4b4)Tff7b72+

Ta5d6ff"Ta5d6ff, round-trip time is Ta5d6ff"Tff7b72+Te6edf3rttstringTff7b72+

Te6edf3reception_stats

Tb4b4b4)

T8b949e# This function is called if a packet times out.

Tff7b72def Td2a8ffpacket_timed_outTb4b4b4(Te6edf3receiptTb4b4b4)Tb4b4b4:

Tff7b72if Te6edf3receiptTff7b72.Td2a8ffstatus Tff7b72== Te6edf3RNSTff7b72.Td2a8ffPacketReceiptTff7b72.Td2a8ffFAILEDTb4b4b4:

Te6edf3RNSTff7b72.Td2a8fflogTb4b4b4(Ta5d6ff"Ta5d6ffPacket Ta5d6ff"Tff7b72+Te6edf3RNSTff7b72.Td2a8ffprettyhexrepTb4b4b4(Te6edf3receiptTff7b72.Td2a8ffhashTb4b4b4)Tff7b72+Ta5d6ff"Ta5d6ff timed outTa5d6ff"Tb4b4b4)

T8b949e##########################################################

T8b949e#### Program Startup #####################################

T8b949e##########################################################

T8b949e# This part of the program gets run at startup,

T8b949e# and parses input from the user, and then starts

T8b949e# the desired program mode.

Tff7b72if Tff7b72__name__ Tff7b72== Ta5d6ff"Ta5d6ff__main__Ta5d6ff"Tb4b4b4:

Tff7b72tryTb4b4b4:

Te6edf3parser Tff7b72= Te6edf3argparseTff7b72.Td2a8ffArgumentParserTb4b4b4(Te6edf3descriptionTff7b72=Ta5d6ff"Ta5d6ffSimple echo server and client utilityTa5d6ff"Tb4b4b4)

Te6edf3parserTff7b72.Td2a8ffadd_argumentTb4b4b4(

Ta5d6ff"Ta5d6ff-sTa5d6ff"Tb4b4b4,

Ta5d6ff"Ta5d6ff--serverTa5d6ff"Tb4b4b4,

Te6edf3actionTff7b72=Ta5d6ff"Ta5d6ffstore_trueTa5d6ff"Tb4b4b4,

Te6edf3helpTff7b72=Ta5d6ff"Ta5d6ffwait for incoming packets from clientsTa5d6ff"

Tb4b4b4)

Te6edf3parserTff7b72.Td2a8ffadd_argumentTb4b4b4(

Ta5d6ff"Ta5d6ff-tTa5d6ff"Tb4b4b4,

Ta5d6ff"Ta5d6ff--timeoutTa5d6ff"Tb4b4b4,

Te6edf3actionTff7b72=Ta5d6ff"Ta5d6ffstoreTa5d6ff"Tb4b4b4,

Te6edf3metavarTff7b72=Ta5d6ff"Ta5d6ffsTa5d6ff"Tb4b4b4,

Te6edf3defaultTff7b72=Tff7b72NoneTb4b4b4,

Te6edf3helpTff7b72=Ta5d6ff"Ta5d6ffset a reply timeout in secondsTa5d6ff"Tb4b4b4,

Tffa657typeTff7b72=Tffa657float

Tb4b4b4)

Te6edf3parserTff7b72.Td2a8ffadd_argumentTb4b4b4(Ta5d6ff"Ta5d6ff--configTa5d6ff"Tb4b4b4,

Te6edf3actionTff7b72=Ta5d6ff"Ta5d6ffstoreTa5d6ff"Tb4b4b4,

Te6edf3defaultTff7b72=Tff7b72NoneTb4b4b4,

Te6edf3helpTff7b72=Ta5d6ff"Ta5d6ffpath to alternative Reticulum config directoryTa5d6ff"Tb4b4b4,

Tffa657typeTff7b72=Tffa657str

Tb4b4b4)

Te6edf3parserTff7b72.Td2a8ffadd_argumentTb4b4b4(

Ta5d6ff"Ta5d6ffdestinationTa5d6ff"Tb4b4b4,

Te6edf3nargsTff7b72=Ta5d6ff"Ta5d6ff?Ta5d6ff"Tb4b4b4,

Te6edf3defaultTff7b72=Tff7b72NoneTb4b4b4,

Te6edf3helpTff7b72=Ta5d6ff"Ta5d6ffhexadecimal hash of the server destinationTa5d6ff"Tb4b4b4,

Tffa657typeTff7b72=Tffa657str

Tb4b4b4)

Te6edf3args Tff7b72= Te6edf3parserTff7b72.Td2a8ffparse_argsTb4b4b4(Tb4b4b4)

Tff7b72if Te6edf3argsTff7b72.Td2a8ffserverTb4b4b4:

Te6edf3configargTff7b72=Tff7b72None

Tff7b72if Te6edf3argsTff7b72.Td2a8ffconfigTb4b4b4:

Te6edf3configarg Tff7b72= Te6edf3argsTff7b72.Td2a8ffconfig

Te6edf3serverTb4b4b4(Te6edf3configargTb4b4b4)

Tff7b72elseTb4b4b4:

Tff7b72if Te6edf3argsTff7b72.Td2a8ffconfigTb4b4b4:

Te6edf3configarg Tff7b72= Te6edf3argsTff7b72.Td2a8ffconfig

Tff7b72elseTb4b4b4:

Te6edf3configarg Tff7b72= Tff7b72None

Tff7b72if Te6edf3argsTff7b72.Td2a8fftimeoutTb4b4b4:

Te6edf3timeoutarg Tff7b72= Tffa657floatTb4b4b4(Te6edf3argsTff7b72.Td2a8fftimeoutTb4b4b4)

Tff7b72elseTb4b4b4:

Te6edf3timeoutarg Tff7b72= Tff7b72None

Tff7b72if Tb4b4b4(Te6edf3argsTff7b72.Td2a8ffdestination Tff7b72== Tff7b72NoneTb4b4b4)Tb4b4b4:

Tffa657printTb4b4b4(Ta5d6ff"Ta5d6ff"Tb4b4b4)

Te6edf3parserTff7b72.Td2a8ffprint_helpTb4b4b4(Tb4b4b4)

Tffa657printTb4b4b4(Ta5d6ff"Ta5d6ff"Tb4b4b4)

Tff7b72elseTb4b4b4:

Te6edf3clientTb4b4b4(Te6edf3argsTff7b72.Td2a8ffdestinationTb4b4b4, Te6edf3configargTb4b4b4, Te6edf3timeoutTff7b72=Te6edf3timeoutargTb4b4b4)

Tff7b72except Tf85149KeyboardInterruptTb4b4b4:

Tffa657printTb4b4b4(Ta5d6ff"Ta5d6ff"Tb4b4b4)

Te6edf3sysTff7b72.Td2a8ffexitTb4b4b4(T79c0ff0Tb4b4b4)

This example can also be found at https://github.com/markqvist/Reticulum/blob/master/Examples/Echo.py.

Link

The Link example explores establishing an encrypted link to a remote destination, and passing traffic back and forth over the link.

T282828

T8b949e##########################################################

T8b949e# This RNS example demonstrates how to set up a link to #

T8b949e# a destination, and pass data back and forth over it. #

T8b949e##########################################################

Tff7b72import T7ee787os

Tff7b72import T7ee787sys

Tff7b72import T7ee787time

Tff7b72import T7ee787argparse

Tff7b72import T7ee787RNS

T8b949e# Let's define an app name. We'll use this for all

T8b949e# destinations we create. Since this echo example

T8b949e# is part of a range of example utilities, we'll put

T8b949e# them all within the app namespace "example_utilities"

Te6edf3APP_NAME Tff7b72= Ta5d6ff"Ta5d6ffexample_utilitiesTa5d6ff"

T8b949e##########################################################

T8b949e#### Server Part #########################################

T8b949e##########################################################

T8b949e# A reference to the latest client link that connected

Te6edf3latest_client_link Tff7b72= Tff7b72None

T8b949e# This initialisation is executed when the users chooses

T8b949e# to run as a server

Tff7b72def Td2a8ffserverTb4b4b4(Te6edf3configpathTb4b4b4)Tb4b4b4:

T8b949e# We must first initialise Reticulum

Te6edf3reticulum Tff7b72= Te6edf3RNSTff7b72.Td2a8ffReticulumTb4b4b4(Te6edf3configpathTb4b4b4)

T8b949e# Randomly create a new identity for our link example

Te6edf3server_identity Tff7b72= Te6edf3RNSTff7b72.Td2a8ffIdentityTb4b4b4(Tb4b4b4)

T8b949e# We create a destination that clients can connect to. We

T8b949e# want clients to create links to this destination, so we

T8b949e# need to create a "single" destination type.

Te6edf3server_destination Tff7b72= Te6edf3RNSTff7b72.Td2a8ffDestinationTb4b4b4(

Te6edf3server_identityTb4b4b4,

Te6edf3RNSTff7b72.Td2a8ffDestinationTff7b72.Td2a8ffINTb4b4b4,

Te6edf3RNSTff7b72.Td2a8ffDestinationTff7b72.Td2a8ffSINGLETb4b4b4,

Te6edf3APP_NAMETb4b4b4,

Ta5d6ff"Ta5d6fflinkexampleTa5d6ff"

Tb4b4b4)

T8b949e# We configure a function that will get called every time

T8b949e# a new client creates a link to this destination.

Te6edf3server_destinationTff7b72.Td2a8ffset_link_established_callbackTb4b4b4(Te6edf3client_connectedTb4b4b4)

T8b949e# Everything's ready!

T8b949e# Let's Wait for client requests or user input

Te6edf3server_loopTb4b4b4(Te6edf3server_destinationTb4b4b4)

Tff7b72def Td2a8ffserver_loopTb4b4b4(Te6edf3destinationTb4b4b4)Tb4b4b4:

T8b949e# Let the user know that everything is ready

Te6edf3RNSTff7b72.Td2a8fflogTb4b4b4(

Ta5d6ff"Ta5d6ffLink example Ta5d6ff"Tff7b72+

Te6edf3RNSTff7b72.Td2a8ffprettyhexrepTb4b4b4(Te6edf3destinationTff7b72.Td2a8ffhashTb4b4b4)Tff7b72+

Ta5d6ff"Ta5d6ff running, waiting for a connection.Ta5d6ff"

Tb4b4b4)

Te6edf3RNSTff7b72.Td2a8fflogTb4b4b4(Ta5d6ff"Ta5d6ffHit enter to manually send an announce (Ctrl-C to quit)Ta5d6ff"Tb4b4b4)

T8b949e# We enter a loop that runs until the users exits.

T8b949e# If the user hits enter, we will announce our server

T8b949e# destination on the network, which will let clients

T8b949e# know how to create messages directed towards it.

Tff7b72while Tff7b72TrueTb4b4b4:

Te6edf3entered Tff7b72= Tffa657inputTb4b4b4(Tb4b4b4)

Te6edf3destinationTff7b72.Td2a8ffannounceTb4b4b4(Tb4b4b4)

Te6edf3RNSTff7b72.Td2a8fflogTb4b4b4(Ta5d6ff"Ta5d6ffSent announce from Ta5d6ff"Tff7b72+Te6edf3RNSTff7b72.Td2a8ffprettyhexrepTb4b4b4(Te6edf3destinationTff7b72.Td2a8ffhashTb4b4b4)Tb4b4b4)

T8b949e# When a client establishes a link to our server

T8b949e# destination, this function will be called with

T8b949e# a reference to the link.

Tff7b72def Td2a8ffclient_connectedTb4b4b4(Te6edf3linkTb4b4b4)Tb4b4b4:

Tff7b72global Te6edf3latest_client_link

Te6edf3RNSTff7b72.Td2a8fflogTb4b4b4(Ta5d6ff"Ta5d6ffClient connectedTa5d6ff"Tb4b4b4)

Te6edf3linkTff7b72.Td2a8ffset_link_closed_callbackTb4b4b4(Te6edf3client_disconnectedTb4b4b4)

Te6edf3linkTff7b72.Td2a8ffset_packet_callbackTb4b4b4(Te6edf3server_packet_receivedTb4b4b4)

Te6edf3latest_client_link Tff7b72= Te6edf3link

Tff7b72def Td2a8ffclient_disconnectedTb4b4b4(Te6edf3linkTb4b4b4)Tb4b4b4:

Te6edf3RNSTff7b72.Td2a8fflogTb4b4b4(Ta5d6ff"Ta5d6ffClient disconnectedTa5d6ff"Tb4b4b4)

Tff7b72def Td2a8ffserver_packet_receivedTb4b4b4(Te6edf3messageTb4b4b4, Te6edf3packetTb4b4b4)Tb4b4b4:

Tff7b72global Te6edf3latest_client_link

T8b949e# When data is received over any active link,

T8b949e# it will all be directed to the last client

T8b949e# that connected.

Te6edf3text Tff7b72= Te6edf3messageTff7b72.Td2a8ffdecodeTb4b4b4(Ta5d6ff"Ta5d6ffutf-8Ta5d6ff"Tb4b4b4)

Te6edf3RNSTff7b72.Td2a8fflogTb4b4b4(Ta5d6ff"Ta5d6ffReceived data on the link: Ta5d6ff"Tff7b72+Te6edf3textTb4b4b4)

Te6edf3reply_text Tff7b72= Ta5d6ff"Ta5d6ffI received Tffea00\"Ta5d6ff"Tff7b72+Te6edf3textTff7b72+Ta5d6ff"Tffea00\"Ta5d6ff over the linkTa5d6ff"

Te6edf3reply_data Tff7b72= Te6edf3reply_textTff7b72.Td2a8ffencodeTb4b4b4(Ta5d6ff"Ta5d6ffutf-8Ta5d6ff"Tb4b4b4)

Te6edf3RNSTff7b72.Td2a8ffPacketTb4b4b4(Te6edf3latest_client_linkTb4b4b4, Te6edf3reply_dataTb4b4b4)Tff7b72.Td2a8ffsendTb4b4b4(Tb4b4b4)

T8b949e##########################################################

T8b949e#### Client Part #########################################

T8b949e##########################################################

T8b949e# A reference to the server link

Te6edf3server_link Tff7b72= Tff7b72None

T8b949e# This initialisation is executed when the users chooses

T8b949e# to run as a client

Tff7b72def Td2a8ffclientTb4b4b4(Te6edf3destination_hexhashTb4b4b4, Te6edf3configpathTb4b4b4)Tb4b4b4:

T8b949e# We need a binary representation of the destination

T8b949e# hash that was entered on the command line

Tff7b72tryTb4b4b4:

Te6edf3dest_len Tff7b72= Tb4b4b4(Te6edf3RNSTff7b72.Td2a8ffReticulumTff7b72.Td2a8ffTRUNCATED_HASHLENGTHTff7b72/Tff7b72/T79c0ff8Tb4b4b4)Tff7b72*T79c0ff2

Tff7b72if Tffa657lenTb4b4b4(Te6edf3destination_hexhashTb4b4b4) Tff7b72!= Te6edf3dest_lenTb4b4b4:

Tff7b72raise Tf85149ValueErrorTb4b4b4(

Tb4b4b4)

Te6edf3destination_hash Tff7b72= Tffa657bytesTff7b72.Td2a8fffromhexTb4b4b4(Te6edf3destination_hexhashTb4b4b4)

Tff7b72exceptTb4b4b4:

Te6edf3RNSTff7b72.Td2a8fflogTb4b4b4(Ta5d6ff"Ta5d6ffInvalid destination entered. Check your input!Tffea00\nTa5d6ff"Tb4b4b4)

Te6edf3sysTff7b72.Td2a8ffexitTb4b4b4(T79c0ff0Tb4b4b4)

T8b949e# We must first initialise Reticulum

Te6edf3reticulum Tff7b72= Te6edf3RNSTff7b72.Td2a8ffReticulumTb4b4b4(Te6edf3configpathTb4b4b4)

T8b949e# Check if we know a path to the destination

Tff7b72if Tff7b72not Te6edf3RNSTff7b72.Td2a8ffTransportTff7b72.Td2a8ffhas_pathTb4b4b4(Te6edf3destination_hashTb4b4b4)Tb4b4b4:

Te6edf3RNSTff7b72.Td2a8fflogTb4b4b4(Ta5d6ff"Ta5d6ffDestination is not yet known. Requesting path and waiting for announce to arrive...Ta5d6ff"Tb4b4b4)

Te6edf3RNSTff7b72.Td2a8ffTransportTff7b72.Td2a8ffrequest_pathTb4b4b4(Te6edf3destination_hashTb4b4b4)

Tff7b72while Tff7b72not Te6edf3RNSTff7b72.Td2a8ffTransportTff7b72.Td2a8ffhas_pathTb4b4b4(Te6edf3destination_hashTb4b4b4)Tb4b4b4:

Te6edf3timeTff7b72.Td2a8ffsleepTb4b4b4(T79c0ff0.1Tb4b4b4)

T8b949e# Recall the server identity

Te6edf3server_identity Tff7b72= Te6edf3RNSTff7b72.Td2a8ffIdentityTff7b72.Td2a8ffrecallTb4b4b4(Te6edf3destination_hashTb4b4b4)

T8b949e# Inform the user that we'll begin connecting

Te6edf3RNSTff7b72.Td2a8fflogTb4b4b4(Ta5d6ff"Ta5d6ffEstablishing link with server...Ta5d6ff"Tb4b4b4)

T8b949e# When the server identity is known, we set

T8b949e# up a destination

Te6edf3server_destination Tff7b72= Te6edf3RNSTff7b72.Td2a8ffDestinationTb4b4b4(

Te6edf3server_identityTb4b4b4,

Te6edf3RNSTff7b72.Td2a8ffDestinationTff7b72.Td2a8ffOUTTb4b4b4,

Te6edf3RNSTff7b72.Td2a8ffDestinationTff7b72.Td2a8ffSINGLETb4b4b4,

Te6edf3APP_NAMETb4b4b4,

Ta5d6ff"Ta5d6fflinkexampleTa5d6ff"

Tb4b4b4)

T8b949e# And create a link

Te6edf3link Tff7b72= Te6edf3RNSTff7b72.Td2a8ffLinkTb4b4b4(Te6edf3server_destinationTb4b4b4)

T8b949e# We set a callback that will get executed

T8b949e# every time a packet is received over the

T8b949e# link

Te6edf3linkTff7b72.Td2a8ffset_packet_callbackTb4b4b4(Te6edf3client_packet_receivedTb4b4b4)

T8b949e# We'll also set up functions to inform the

T8b949e# user when the link is established or closed

Te6edf3linkTff7b72.Td2a8ffset_link_established_callbackTb4b4b4(Te6edf3link_establishedTb4b4b4)

Te6edf3linkTff7b72.Td2a8ffset_link_closed_callbackTb4b4b4(Te6edf3link_closedTb4b4b4)

T8b949e# Everything is set up, so let's enter a loop

T8b949e# for the user to interact with the example

Te6edf3client_loopTb4b4b4(Tb4b4b4)

Tff7b72def Td2a8ffclient_loopTb4b4b4(Tb4b4b4)Tb4b4b4:

Tff7b72global Te6edf3server_link

T8b949e# Wait for the link to become active

Tff7b72while Tff7b72not Te6edf3server_linkTb4b4b4:

Te6edf3timeTff7b72.Td2a8ffsleepTb4b4b4(T79c0ff0.1Tb4b4b4)

Te6edf3should_quit Tff7b72= Tff7b72False

Tff7b72while Tff7b72not Te6edf3should_quitTb4b4b4:

Tff7b72tryTb4b4b4:

Tffa657printTb4b4b4(Ta5d6ff"Ta5d6ff> Ta5d6ff"Tb4b4b4, Te6edf3endTff7b72=Ta5d6ff"Ta5d6ff Ta5d6ff"Tb4b4b4)

Te6edf3text Tff7b72= Tffa657inputTb4b4b4(Tb4b4b4)

T8b949e# Check if we should quit the example

Tff7b72if Te6edf3text Tff7b72== Ta5d6ff"Ta5d6ffquitTa5d6ff" Tff7b72or Te6edf3text Tff7b72== Ta5d6ff"Ta5d6ffqTa5d6ff" Tff7b72or Te6edf3text Tff7b72== Ta5d6ff"Ta5d6ffexitTa5d6ff"Tb4b4b4:

Te6edf3should_quit Tff7b72= Tff7b72True

Te6edf3server_linkTff7b72.Td2a8ffteardownTb4b4b4(Tb4b4b4)

T8b949e# If not, send the entered text over the link

Tff7b72if Te6edf3text Tff7b72!= Ta5d6ff"Ta5d6ff"Tb4b4b4:

Te6edf3data Tff7b72= Te6edf3textTff7b72.Td2a8ffencodeTb4b4b4(Ta5d6ff"Ta5d6ffutf-8Ta5d6ff"Tb4b4b4)

Tff7b72if Tffa657lenTb4b4b4(Te6edf3dataTb4b4b4) Tff7b72<Tff7b72= Te6edf3RNSTff7b72.Td2a8ffLinkTff7b72.Td2a8ffMDUTb4b4b4:

Te6edf3RNSTff7b72.Td2a8ffPacketTb4b4b4(Te6edf3server_linkTb4b4b4, Te6edf3dataTb4b4b4)Tff7b72.Td2a8ffsendTb4b4b4(Tb4b4b4)

Tff7b72elseTb4b4b4:

Te6edf3RNSTff7b72.Td2a8fflogTb4b4b4(

Ta5d6ff"Ta5d6ffCannot send this packet, the data size of Ta5d6ff"Tff7b72+

Tffa657strTb4b4b4(Tffa657lenTb4b4b4(Te6edf3dataTb4b4b4)Tb4b4b4)Tff7b72+Ta5d6ff"Ta5d6ff bytes exceeds the link packet MDU of Ta5d6ff"Tff7b72+

Tffa657strTb4b4b4(Te6edf3RNSTff7b72.Td2a8ffLinkTff7b72.Td2a8ffMDUTb4b4b4)Tff7b72+Ta5d6ff"Ta5d6ff bytesTa5d6ff"Tb4b4b4,

Te6edf3RNSTff7b72.Td2a8ffLOG_ERROR

Tb4b4b4)

Tff7b72except Tf85149Exception Tff7b72as Te6edf3eTb4b4b4:

Te6edf3RNSTff7b72.Td2a8fflogTb4b4b4(Ta5d6ff"Ta5d6ffError while sending data over the link: Ta5d6ff"Tff7b72+Tffa657strTb4b4b4(Te6edf3eTb4b4b4)Tb4b4b4)

Te6edf3should_quit Tff7b72= Tff7b72True

Te6edf3server_linkTff7b72.Td2a8ffteardownTb4b4b4(Tb4b4b4)

T8b949e# This function is called when a link

T8b949e# has been established with the server

Tff7b72def Td2a8fflink_establishedTb4b4b4(Te6edf3linkTb4b4b4)Tb4b4b4:

T8b949e# We store a reference to the link

T8b949e# instance for later use

Tff7b72global Te6edf3server_link

Te6edf3server_link Tff7b72= Te6edf3link

T8b949e# Inform the user that the server is

T8b949e# connected

Te6edf3RNSTff7b72.Td2a8fflogTb4b4b4(Ta5d6ff"Ta5d6ffLink established with server, enter some text to send, or Tffea00\"Ta5d6ffquitTffea00\"Ta5d6ff to quitTa5d6ff"Tb4b4b4)

T8b949e# When a link is closed, we'll inform the

T8b949e# user, and exit the program

Tff7b72def Td2a8fflink_closedTb4b4b4(Te6edf3linkTb4b4b4)Tb4b4b4:

Tff7b72if Te6edf3linkTff7b72.Td2a8ffteardown_reason Tff7b72== Te6edf3RNSTff7b72.Td2a8ffLinkTff7b72.Td2a8ffTIMEOUTTb4b4b4:

Te6edf3RNSTff7b72.Td2a8fflogTb4b4b4(Ta5d6ff"Ta5d6ffThe link timed out, exiting nowTa5d6ff"Tb4b4b4)

Tff7b72elif Te6edf3linkTff7b72.Td2a8ffteardown_reason Tff7b72== Te6edf3RNSTff7b72.Td2a8ffLinkTff7b72.Td2a8ffDESTINATION_CLOSEDTb4b4b4:

Te6edf3RNSTff7b72.Td2a8fflogTb4b4b4(Ta5d6ff"Ta5d6ffThe link was closed by the server, exiting nowTa5d6ff"Tb4b4b4)

Tff7b72elseTb4b4b4:

Te6edf3RNSTff7b72.Td2a8fflogTb4b4b4(Ta5d6ff"Ta5d6ffLink closed, exiting nowTa5d6ff"Tb4b4b4)

Te6edf3timeTff7b72.Td2a8ffsleepTb4b4b4(T79c0ff1.5Tb4b4b4)

Te6edf3sysTff7b72.Td2a8ffexitTb4b4b4(T79c0ff0Tb4b4b4)

T8b949e# When a packet is received over the link, we

T8b949e# simply print out the data.

Tff7b72def Td2a8ffclient_packet_receivedTb4b4b4(Te6edf3messageTb4b4b4, Te6edf3packetTb4b4b4)Tb4b4b4:

Te6edf3text Tff7b72= Te6edf3messageTff7b72.Td2a8ffdecodeTb4b4b4(Ta5d6ff"Ta5d6ffutf-8Ta5d6ff"Tb4b4b4)

Te6edf3RNSTff7b72.Td2a8fflogTb4b4b4(Ta5d6ff"Ta5d6ffReceived data on the link: Ta5d6ff"Tff7b72+Te6edf3textTb4b4b4)

Tffa657printTb4b4b4(Ta5d6ff"Ta5d6ff> Ta5d6ff"Tb4b4b4, Te6edf3endTff7b72=Ta5d6ff"Ta5d6ff Ta5d6ff"Tb4b4b4)

Te6edf3sysTff7b72.Td2a8ffstdoutTff7b72.Td2a8ffflushTb4b4b4(Tb4b4b4)

T8b949e##########################################################

T8b949e#### Program Startup #####################################

T8b949e##########################################################

T8b949e# This part of the program runs at startup,

T8b949e# and parses input of from the user, and then

T8b949e# starts up the desired program mode.

Tff7b72if Tff7b72__name__ Tff7b72== Ta5d6ff"Ta5d6ff__main__Ta5d6ff"Tb4b4b4:

Tff7b72tryTb4b4b4:

Te6edf3parser Tff7b72= Te6edf3argparseTff7b72.Td2a8ffArgumentParserTb4b4b4(Te6edf3descriptionTff7b72=Ta5d6ff"Ta5d6ffSimple link exampleTa5d6ff"Tb4b4b4)

Te6edf3parserTff7b72.Td2a8ffadd_argumentTb4b4b4(

Ta5d6ff"Ta5d6ff-sTa5d6ff"Tb4b4b4,

Ta5d6ff"Ta5d6ff--serverTa5d6ff"Tb4b4b4,

Te6edf3actionTff7b72=Ta5d6ff"Ta5d6ffstore_trueTa5d6ff"Tb4b4b4,

Te6edf3helpTff7b72=Ta5d6ff"Ta5d6ffwait for incoming link requests from clientsTa5d6ff"

Tb4b4b4)

Te6edf3parserTff7b72.Td2a8ffadd_argumentTb4b4b4(

Ta5d6ff"Ta5d6ff--configTa5d6ff"Tb4b4b4,

Te6edf3actionTff7b72=Ta5d6ff"Ta5d6ffstoreTa5d6ff"Tb4b4b4,

Te6edf3defaultTff7b72=Tff7b72NoneTb4b4b4,

Te6edf3helpTff7b72=Ta5d6ff"Ta5d6ffpath to alternative Reticulum config directoryTa5d6ff"Tb4b4b4,

Tffa657typeTff7b72=Tffa657str

Tb4b4b4)

Te6edf3parserTff7b72.Td2a8ffadd_argumentTb4b4b4(

Ta5d6ff"Ta5d6ffdestinationTa5d6ff"Tb4b4b4,

Te6edf3nargsTff7b72=Ta5d6ff"Ta5d6ff?Ta5d6ff"Tb4b4b4,

Te6edf3defaultTff7b72=Tff7b72NoneTb4b4b4,

Te6edf3helpTff7b72=Ta5d6ff"Ta5d6ffhexadecimal hash of the server destinationTa5d6ff"Tb4b4b4,

Tffa657typeTff7b72=Tffa657str

Tb4b4b4)

Te6edf3args Tff7b72= Te6edf3parserTff7b72.Td2a8ffparse_argsTb4b4b4(Tb4b4b4)

Tff7b72if Te6edf3argsTff7b72.Td2a8ffconfigTb4b4b4:

Te6edf3configarg Tff7b72= Te6edf3argsTff7b72.Td2a8ffconfig

Tff7b72elseTb4b4b4:

Te6edf3configarg Tff7b72= Tff7b72None

Tff7b72if Te6edf3argsTff7b72.Td2a8ffserverTb4b4b4:

Te6edf3serverTb4b4b4(Te6edf3configargTb4b4b4)

Tff7b72elseTb4b4b4:

Tff7b72if Tb4b4b4(Te6edf3argsTff7b72.Td2a8ffdestination Tff7b72== Tff7b72NoneTb4b4b4)Tb4b4b4:

Tffa657printTb4b4b4(Ta5d6ff"Ta5d6ff"Tb4b4b4)

Te6edf3parserTff7b72.Td2a8ffprint_helpTb4b4b4(Tb4b4b4)

Tffa657printTb4b4b4(Ta5d6ff"Ta5d6ff"Tb4b4b4)

Tff7b72elseTb4b4b4:

Te6edf3clientTb4b4b4(Te6edf3argsTff7b72.Td2a8ffdestinationTb4b4b4, Te6edf3configargTb4b4b4)

Tff7b72except Tf85149KeyboardInterruptTb4b4b4:

Tffa657printTb4b4b4(Ta5d6ff"Ta5d6ff"Tb4b4b4)

Te6edf3sysTff7b72.Td2a8ffexitTb4b4b4(T79c0ff0Tb4b4b4)

This example can also be found at https://github.com/markqvist/Reticulum/blob/master/Examples/Link.py.

Identification

The Identify example explores identifying an intiator of a link, once the link has been established.

T282828

T8b949e##########################################################

T8b949e# This RNS example demonstrates how to set up a link to #

T8b949e# a destination, and identify the initiator to it's peer #

T8b949e##########################################################

Tff7b72import T7ee787os

Tff7b72import T7ee787sys

Tff7b72import T7ee787time

Tff7b72import T7ee787argparse

Tff7b72import T7ee787RNS

T8b949e# Let's define an app name. We'll use this for all

T8b949e# destinations we create. Since this echo example

T8b949e# is part of a range of example utilities, we'll put

T8b949e# them all within the app namespace "example_utilities"

Te6edf3APP_NAME Tff7b72= Ta5d6ff"Ta5d6ffexample_utilitiesTa5d6ff"

T8b949e##########################################################

T8b949e#### Server Part #########################################

T8b949e##########################################################

T8b949e# A reference to the latest client link that connected

Te6edf3latest_client_link Tff7b72= Tff7b72None

T8b949e# This initialisation is executed when the users chooses

T8b949e# to run as a server

Tff7b72def Td2a8ffserverTb4b4b4(Te6edf3configpathTb4b4b4)Tb4b4b4:

T8b949e# We must first initialise Reticulum

Te6edf3reticulum Tff7b72= Te6edf3RNSTff7b72.Td2a8ffReticulumTb4b4b4(Te6edf3configpathTb4b4b4)

T8b949e# Randomly create a new identity for our link example

Te6edf3server_identity Tff7b72= Te6edf3RNSTff7b72.Td2a8ffIdentityTb4b4b4(Tb4b4b4)

T8b949e# We create a destination that clients can connect to. We

T8b949e# want clients to create links to this destination, so we

T8b949e# need to create a "single" destination type.

Te6edf3server_destination Tff7b72= Te6edf3RNSTff7b72.Td2a8ffDestinationTb4b4b4(

Te6edf3server_identityTb4b4b4,

Te6edf3RNSTff7b72.Td2a8ffDestinationTff7b72.Td2a8ffINTb4b4b4,

Te6edf3RNSTff7b72.Td2a8ffDestinationTff7b72.Td2a8ffSINGLETb4b4b4,

Te6edf3APP_NAMETb4b4b4,

Ta5d6ff"Ta5d6ffidentifyexampleTa5d6ff"

Tb4b4b4)

T8b949e# We configure a function that will get called every time

T8b949e# a new client creates a link to this destination.

Te6edf3server_destinationTff7b72.Td2a8ffset_link_established_callbackTb4b4b4(Te6edf3client_connectedTb4b4b4)

T8b949e# Everything's ready!

T8b949e# Let's Wait for client requests or user input

Te6edf3server_loopTb4b4b4(Te6edf3server_destinationTb4b4b4)

Tff7b72def Td2a8ffserver_loopTb4b4b4(Te6edf3destinationTb4b4b4)Tb4b4b4:

T8b949e# Let the user know that everything is ready

Te6edf3RNSTff7b72.Td2a8fflogTb4b4b4(

Ta5d6ff"Ta5d6ffLink identification example Ta5d6ff"Tff7b72+

Te6edf3RNSTff7b72.Td2a8ffprettyhexrepTb4b4b4(Te6edf3destinationTff7b72.Td2a8ffhashTb4b4b4)Tff7b72+

Ta5d6ff"Ta5d6ff running, waiting for a connection.Ta5d6ff"

Tb4b4b4)

Te6edf3RNSTff7b72.Td2a8fflogTb4b4b4(Ta5d6ff"Ta5d6ffHit enter to manually send an announce (Ctrl-C to quit)Ta5d6ff"Tb4b4b4)

T8b949e# We enter a loop that runs until the users exits.

T8b949e# If the user hits enter, we will announce our server

T8b949e# destination on the network, which will let clients

T8b949e# know how to create messages directed towards it.

Tff7b72while Tff7b72TrueTb4b4b4:

Te6edf3entered Tff7b72= Tffa657inputTb4b4b4(Tb4b4b4)

Te6edf3destinationTff7b72.Td2a8ffannounceTb4b4b4(Tb4b4b4)

Te6edf3RNSTff7b72.Td2a8fflogTb4b4b4(Ta5d6ff"Ta5d6ffSent announce from Ta5d6ff"Tff7b72+Te6edf3RNSTff7b72.Td2a8ffprettyhexrepTb4b4b4(Te6edf3destinationTff7b72.Td2a8ffhashTb4b4b4)Tb4b4b4)

T8b949e# When a client establishes a link to our server

T8b949e# destination, this function will be called with

T8b949e# a reference to the link.

Tff7b72def Td2a8ffclient_connectedTb4b4b4(Te6edf3linkTb4b4b4)Tb4b4b4:

Tff7b72global Te6edf3latest_client_link

Te6edf3RNSTff7b72.Td2a8fflogTb4b4b4(Ta5d6ff"Ta5d6ffClient connectedTa5d6ff"Tb4b4b4)

Te6edf3linkTff7b72.Td2a8ffset_link_closed_callbackTb4b4b4(Te6edf3client_disconnectedTb4b4b4)

Te6edf3linkTff7b72.Td2a8ffset_packet_callbackTb4b4b4(Te6edf3server_packet_receivedTb4b4b4)

Te6edf3linkTff7b72.Td2a8ffset_remote_identified_callbackTb4b4b4(Te6edf3remote_identifiedTb4b4b4)

Te6edf3latest_client_link Tff7b72= Te6edf3link

Tff7b72def Td2a8ffclient_disconnectedTb4b4b4(Te6edf3linkTb4b4b4)Tb4b4b4:

Te6edf3RNSTff7b72.Td2a8fflogTb4b4b4(Ta5d6ff"Ta5d6ffClient disconnectedTa5d6ff"Tb4b4b4)

Tff7b72def Td2a8ffremote_identifiedTb4b4b4(Te6edf3linkTb4b4b4, Te6edf3identityTb4b4b4)Tb4b4b4:

Te6edf3RNSTff7b72.Td2a8fflogTb4b4b4(Ta5d6ff"Ta5d6ffRemote identified as: Ta5d6ff"Tff7b72+Tffa657strTb4b4b4(Te6edf3identityTb4b4b4)Tb4b4b4)

Tff7b72def Td2a8ffserver_packet_receivedTb4b4b4(Te6edf3messageTb4b4b4, Te6edf3packetTb4b4b4)Tb4b4b4:

Tff7b72global Te6edf3latest_client_link

T8b949e# Get the originating identity for display

Te6edf3remote_peer Tff7b72= Ta5d6ff"Ta5d6ffunidentified peerTa5d6ff"

Tff7b72if Te6edf3packetTff7b72.Td2a8fflinkTff7b72.Td2a8ffget_remote_identityTb4b4b4(Tb4b4b4) Tff7b72!= Tff7b72NoneTb4b4b4:

Te6edf3remote_peer Tff7b72= Tffa657strTb4b4b4(Te6edf3packetTff7b72.Td2a8fflinkTff7b72.Td2a8ffget_remote_identityTb4b4b4(Tb4b4b4)Tb4b4b4)

T8b949e# When data is received over any active link,

T8b949e# it will all be directed to the last client

T8b949e# that connected.

Te6edf3text Tff7b72= Te6edf3messageTff7b72.Td2a8ffdecodeTb4b4b4(Ta5d6ff"Ta5d6ffutf-8Ta5d6ff"Tb4b4b4)

Te6edf3RNSTff7b72.Td2a8fflogTb4b4b4(Ta5d6ff"Ta5d6ffReceived data from Ta5d6ff"Tff7b72+Te6edf3remote_peerTff7b72+Ta5d6ff"Ta5d6ff: Ta5d6ff"Tff7b72+Te6edf3textTb4b4b4)

Te6edf3reply_text Tff7b72= Ta5d6ff"Ta5d6ffI received Tffea00\"Ta5d6ff"Tff7b72+Te6edf3textTff7b72+Ta5d6ff"Tffea00\"Ta5d6ff over the link from Ta5d6ff"Tff7b72+Te6edf3remote_peer

Te6edf3reply_data Tff7b72= Te6edf3reply_textTff7b72.Td2a8ffencodeTb4b4b4(Ta5d6ff"Ta5d6ffutf-8Ta5d6ff"Tb4b4b4)

Te6edf3RNSTff7b72.Td2a8ffPacketTb4b4b4(Te6edf3latest_client_linkTb4b4b4, Te6edf3reply_dataTb4b4b4)Tff7b72.Td2a8ffsendTb4b4b4(Tb4b4b4)

T8b949e##########################################################

T8b949e#### Client Part #########################################

T8b949e##########################################################

T8b949e# A reference to the server link

Te6edf3server_link Tff7b72= Tff7b72None

T8b949e# A reference to the client identity

Te6edf3client_identity Tff7b72= Tff7b72None

T8b949e# This initialisation is executed when the users chooses

T8b949e# to run as a client

Tff7b72def Td2a8ffclientTb4b4b4(Te6edf3destination_hexhashTb4b4b4, Te6edf3configpathTb4b4b4)Tb4b4b4:

Tff7b72global Te6edf3client_identity

T8b949e# We need a binary representation of the destination

T8b949e# hash that was entered on the command line

Tff7b72tryTb4b4b4:

Te6edf3dest_len Tff7b72= Tb4b4b4(Te6edf3RNSTff7b72.Td2a8ffReticulumTff7b72.Td2a8ffTRUNCATED_HASHLENGTHTff7b72/Tff7b72/T79c0ff8Tb4b4b4)Tff7b72*T79c0ff2

Tff7b72if Tffa657lenTb4b4b4(Te6edf3destination_hexhashTb4b4b4) Tff7b72!= Te6edf3dest_lenTb4b4b4:

Tff7b72raise Tf85149ValueErrorTb4b4b4(

Tb4b4b4)

Te6edf3destination_hash Tff7b72= Tffa657bytesTff7b72.Td2a8fffromhexTb4b4b4(Te6edf3destination_hexhashTb4b4b4)

Tff7b72exceptTb4b4b4:

Te6edf3RNSTff7b72.Td2a8fflogTb4b4b4(Ta5d6ff"Ta5d6ffInvalid destination entered. Check your input!Tffea00\nTa5d6ff"Tb4b4b4)

Te6edf3sysTff7b72.Td2a8ffexitTb4b4b4(T79c0ff0Tb4b4b4)

T8b949e# We must first initialise Reticulum

Te6edf3reticulum Tff7b72= Te6edf3RNSTff7b72.Td2a8ffReticulumTb4b4b4(Te6edf3configpathTb4b4b4)

T8b949e# Create a new client identity

Te6edf3client_identity Tff7b72= Te6edf3RNSTff7b72.Td2a8ffIdentityTb4b4b4(Tb4b4b4)

Te6edf3RNSTff7b72.Td2a8fflogTb4b4b4(

Ta5d6ff"Ta5d6ffClient created new identity Ta5d6ff"Tff7b72+

Tffa657strTb4b4b4(Te6edf3client_identityTb4b4b4)

Tb4b4b4)

T8b949e# Check if we know a path to the destination

Tff7b72if Tff7b72not Te6edf3RNSTff7b72.Td2a8ffTransportTff7b72.Td2a8ffhas_pathTb4b4b4(Te6edf3destination_hashTb4b4b4)Tb4b4b4:

Te6edf3RNSTff7b72.Td2a8fflogTb4b4b4(Ta5d6ff"Ta5d6ffDestination is not yet known. Requesting path and waiting for announce to arrive...Ta5d6ff"Tb4b4b4)

Te6edf3RNSTff7b72.Td2a8ffTransportTff7b72.Td2a8ffrequest_pathTb4b4b4(Te6edf3destination_hashTb4b4b4)

Tff7b72while Tff7b72not Te6edf3RNSTff7b72.Td2a8ffTransportTff7b72.Td2a8ffhas_pathTb4b4b4(Te6edf3destination_hashTb4b4b4)Tb4b4b4:

Te6edf3timeTff7b72.Td2a8ffsleepTb4b4b4(T79c0ff0.1Tb4b4b4)

T8b949e# Recall the server identity

Te6edf3server_identity Tff7b72= Te6edf3RNSTff7b72.Td2a8ffIdentityTff7b72.Td2a8ffrecallTb4b4b4(Te6edf3destination_hashTb4b4b4)

T8b949e# Inform the user that we'll begin connecting

Te6edf3RNSTff7b72.Td2a8fflogTb4b4b4(Ta5d6ff"Ta5d6ffEstablishing link with server...Ta5d6ff"Tb4b4b4)

T8b949e# When the server identity is known, we set

T8b949e# up a destination

Te6edf3server_destination Tff7b72= Te6edf3RNSTff7b72.Td2a8ffDestinationTb4b4b4(

Te6edf3server_identityTb4b4b4,

Te6edf3RNSTff7b72.Td2a8ffDestinationTff7b72.Td2a8ffOUTTb4b4b4,

Te6edf3RNSTff7b72.Td2a8ffDestinationTff7b72.Td2a8ffSINGLETb4b4b4,

Te6edf3APP_NAMETb4b4b4,

Ta5d6ff"Ta5d6ffidentifyexampleTa5d6ff"

Tb4b4b4)

T8b949e# And create a link

Te6edf3link Tff7b72= Te6edf3RNSTff7b72.Td2a8ffLinkTb4b4b4(Te6edf3server_destinationTb4b4b4)

T8b949e# We set a callback that will get executed

T8b949e# every time a packet is received over the

T8b949e# link

Te6edf3linkTff7b72.Td2a8ffset_packet_callbackTb4b4b4(Te6edf3client_packet_receivedTb4b4b4)

T8b949e# We'll also set up functions to inform the

T8b949e# user when the link is established or closed

Te6edf3linkTff7b72.Td2a8ffset_link_established_callbackTb4b4b4(Te6edf3link_establishedTb4b4b4)

Te6edf3linkTff7b72.Td2a8ffset_link_closed_callbackTb4b4b4(Te6edf3link_closedTb4b4b4)

T8b949e# Everything is set up, so let's enter a loop

T8b949e# for the user to interact with the example

Te6edf3client_loopTb4b4b4(Tb4b4b4)

Tff7b72def Td2a8ffclient_loopTb4b4b4(Tb4b4b4)Tb4b4b4:

Tff7b72global Te6edf3server_link

T8b949e# Wait for the link to become active

Tff7b72while Tff7b72not Te6edf3server_linkTb4b4b4:

Te6edf3timeTff7b72.Td2a8ffsleepTb4b4b4(T79c0ff0.1Tb4b4b4)

Te6edf3should_quit Tff7b72= Tff7b72False

Tff7b72while Tff7b72not Te6edf3should_quitTb4b4b4:

Tff7b72tryTb4b4b4:

Tffa657printTb4b4b4(Ta5d6ff"Ta5d6ff> Ta5d6ff"Tb4b4b4, Te6edf3endTff7b72=Ta5d6ff"Ta5d6ff Ta5d6ff"Tb4b4b4)

Te6edf3text Tff7b72= Tffa657inputTb4b4b4(Tb4b4b4)

T8b949e# Check if we should quit the example

Tff7b72if Te6edf3text Tff7b72== Ta5d6ff"Ta5d6ffquitTa5d6ff" Tff7b72or Te6edf3text Tff7b72== Ta5d6ff"Ta5d6ffqTa5d6ff" Tff7b72or Te6edf3text Tff7b72== Ta5d6ff"Ta5d6ffexitTa5d6ff"Tb4b4b4:

Te6edf3should_quit Tff7b72= Tff7b72True

Te6edf3server_linkTff7b72.Td2a8ffteardownTb4b4b4(Tb4b4b4)

T8b949e# If not, send the entered text over the link

Tff7b72if Te6edf3text Tff7b72!= Ta5d6ff"Ta5d6ff"Tb4b4b4:

Te6edf3data Tff7b72= Te6edf3textTff7b72.Td2a8ffencodeTb4b4b4(Ta5d6ff"Ta5d6ffutf-8Ta5d6ff"Tb4b4b4)

Tff7b72if Tffa657lenTb4b4b4(Te6edf3dataTb4b4b4) Tff7b72<Tff7b72= Te6edf3RNSTff7b72.Td2a8ffLinkTff7b72.Td2a8ffMDUTb4b4b4:

Te6edf3RNSTff7b72.Td2a8ffPacketTb4b4b4(Te6edf3server_linkTb4b4b4, Te6edf3dataTb4b4b4)Tff7b72.Td2a8ffsendTb4b4b4(Tb4b4b4)

Tff7b72elseTb4b4b4:

Te6edf3RNSTff7b72.Td2a8fflogTb4b4b4(

Ta5d6ff"Ta5d6ffCannot send this packet, the data size of Ta5d6ff"Tff7b72+

Tffa657strTb4b4b4(Tffa657lenTb4b4b4(Te6edf3dataTb4b4b4)Tb4b4b4)Tff7b72+Ta5d6ff"Ta5d6ff bytes exceeds the link packet MDU of Ta5d6ff"Tff7b72+

Tffa657strTb4b4b4(Te6edf3RNSTff7b72.Td2a8ffLinkTff7b72.Td2a8ffMDUTb4b4b4)Tff7b72+Ta5d6ff"Ta5d6ff bytesTa5d6ff"Tb4b4b4,

Te6edf3RNSTff7b72.Td2a8ffLOG_ERROR

Tb4b4b4)

Tff7b72except Tf85149Exception Tff7b72as Te6edf3eTb4b4b4:

Te6edf3RNSTff7b72.Td2a8fflogTb4b4b4(Ta5d6ff"Ta5d6ffError while sending data over the link: Ta5d6ff"Tff7b72+Tffa657strTb4b4b4(Te6edf3eTb4b4b4)Tb4b4b4)

Te6edf3should_quit Tff7b72= Tff7b72True

Te6edf3server_linkTff7b72.Td2a8ffteardownTb4b4b4(Tb4b4b4)

T8b949e# This function is called when a link

T8b949e# has been established with the server

Tff7b72def Td2a8fflink_establishedTb4b4b4(Te6edf3linkTb4b4b4)Tb4b4b4:

T8b949e# We store a reference to the link

T8b949e# instance for later use

Tff7b72global Te6edf3server_linkTb4b4b4, Te6edf3client_identity

Te6edf3server_link Tff7b72= Te6edf3link

T8b949e# Inform the user that the server is

T8b949e# connected

Te6edf3RNSTff7b72.Td2a8fflogTb4b4b4(Ta5d6ff"Ta5d6ffLink established with server, identifying to remote peer...Ta5d6ff"Tb4b4b4)

Te6edf3linkTff7b72.Td2a8ffidentifyTb4b4b4(Te6edf3client_identityTb4b4b4)